home *** CD-ROM | disk | FTP | other *** search
/ Beginning Mac Programming / Beginning Mac Programming.bin / Open Me for REALbasic 3 / REALbasic 3.2 / Example Projects / Reusable Classes_Code / User Interface / KeyCanvas Plugin a1 / KeyCanvas Source / TempelMann Readme2 < prev   
Text File  |  1999-11-27  |  4KB  |  68 lines
  1. TT's Plugin Starter for REALbasic 2.0 plugins
  2.  
  3. Created Nov 1999 by Thomas Tempelmann
  4. Last edit: 27 Nov 1999
  5.  
  6. The plugin and all other enclosed code is to be considered freeware, that is, to be made available to anyone for free.
  7.  
  8. Updates and more information on my sample code:
  9.     <http://www.tempel.org/rb/>
  10.  
  11. You should also have REALsoftware's Plugin API, available from:
  12.     <http://www.realsoftware.com/files/pluginsdk.sea.bin>
  13.  
  14.  
  15. Introduction
  16.  
  17. The enclosed Metrowerks project and C source code serves as a starting point to create plugins for Mac OS (68K and PPC) and Windows (x86) platforms.
  18.  
  19. It contains examples for creating global methods as well as adding new classes and extending existing classes.
  20.  
  21. There's currently no sample code included for creating new controls, but I might add that later. Check my website for updates.
  22. For now, if you want to create a control using a plugin, you might still use my code as a starting point and then add source code from one of the sample projects that are included in REALsoftware's Plugin API.
  23.  
  24.  
  25. Using the Starter
  26.  
  27. There's two project files, depending on your needs and the CodeWarrior version you have:
  28.  
  29. • Plugin Prj    —    requires CW Pro 4 (IDE 3.3) and supports Windows (x86) plugins
  30. • Plugin Prj (CWPro2)    —    requires CW Pro 2 and does not support Windows (x86) plugins.
  31.  
  32. In case you need Windows support
  33.  
  34. To avoid difficulties, you should use CodeWarrior Pro 4 or higher if possible. Older versions will cause some of the settings getting lost and replaced by default values. Worst of all, the PostLinker plugin (see below) does not work with Pro2 (it may work with Pro3, but I did not test that).
  35.  
  36. If you plan to create x86 plugins (for use under Windows), you must copy the two files inside the folder Into "CodeWarrior Plugins" ƒ into your CW Plugins folder before launching CodeWarrior, or you'll get an error message like this when opening the Starter project file:
  37. Could not find post-linker “RB DLL Plugin PostLinker” for target “x86 code”
  38.  
  39. However, if you do not need your plugin to work under Windows, you can remove the "x86" target from the project instead.
  40.  
  41. In case you do not need Windows support
  42.  
  43. If you have Pro4 or higher, I suggest to use the project file Plugin Prj and remove the x86 target from it. Otherwise, use the project file Plugin Prj (CWPro2).
  44.  
  45. If you use CW Pro 4
  46.  
  47. You should update your Pro 4 installation to use the latest IDE, CW plugins and libraries. E.g, the IDE I used for the project is v3.3. You can download the updates from:
  48.     <ftp://ftp.metrowerks.com//pub/updates/CWPRO4/>
  49.  
  50. Compiling and testing the plugin
  51.  
  52. Open the project file, make it, and copy the created plugin Untitled Plugin into RB's Plugins folder. Then open the file TestApp.rbp and run it. It should work just fine. Try also building a 68K-only version and run it to see if it works.
  53.  
  54. Finally, if you want Windows support, build the Windows executable and test it. If you did not modify the project source, you'll probably get a "Unhandled Exception" error in Windows. That's because RB currently does not properly support Classes created in plugins for Windows: Under Windows, RB plugins can only provide global methods, extend existing classes and create new controls. Hopefully, before the RB 2.1 release, creating new classes is made possible, too.
  55.  
  56.  
  57. Getting more help & information on plugin programming
  58.  
  59. If you need more information about writing plugins, check out my website mentioned above - there's plenty of plugins, and they all come with source code. You might learn a lot from them.
  60.  
  61. Another source for help is the plugins mailing list. There's usually less than 10-20 messages per week, so subscribing to it just for curiosity does not hurt. To join,  send a mail with the message "subscribe realbasic-plugins" to
  62.     <mailto:quests@lists.realsoftware.com>.
  63.  
  64.  
  65. And now, I wish you good luck with your plugin writing efforts.
  66.  
  67.     Thomas Tempelmann, 27 Nov 99
  68.